Telephone Keypad Key Sequence Parameters

The telephony keypad key sequence parameters are described in the table below.

Telephone Keypad Key Sequence Parameters

Parameter

Description

'Call Pickup Key'

configure voip > sip-definition settings > call-pickup-key

[KeyCallPickup]

Defines the key sequence on the phone's keypad for performing a call pick-up. Call pick-up allows the FXS endpoint to answer another telephone's incoming call by pressing this user-defined sequence of digits. When the user dials these digits (e.g., #77), incoming calls from another phone is forwarded to the user's phone.

The valid value is a string of up to 15 characters (0-9, #, and *). By default, no value is defined.

Note:

Call pick-up is configured only for FXS endpoints pertaining to the same Trunk Group.
The parameter is applicable only to FXS interfaces.

configure voip > gateway analog keypad-features key-port-configure

[KeyPortConfigure]

Defines the key sequence on the phone's keypad for configuring a phone number for the FXS phone that is connected to the device's FXS port.

To configure the phone number:

1. Press the keys on the keypad to enter the configured key sequence.
2. Press the keys on the keypad to enter the phone number.
3. Press the number sign key (#) to complete configuration.

For example, if you configured the parameter to "*81" and you want the phone number to be 9764004, press the following keys on the keypad: *819764004#.

To delete the phone number, simply press the configured key sequence with the # key at the end (e.g., *81#).

The valid value is a string of up to 16 characters. By default, no value is defined.

Note:

You must assign the FXS port to a Trunk Group (in the Trunk Group table) that is dedicated only to this port. The Trunk Group can be configured with or without a phone number, which you can change or delete by using this parameter.
The parameter is applicable only to FXS interfaces.

[Prefix2ExtLine]

Defines a string prefix (e.g., 9 dialed for an external line) that when dialed, the device plays a secondary dial tone (i.e., stutter tone) to the FXS line and then starts collecting the subsequently dialed digits from the FXS line.

The valid value is a string of up to three characters, which can include digits (0-9), #, and * (e.g., *72). By default, no value is defined.

Note:

You can enable the device to add this string as the prefix to the collected (and sent) digits, using the [AddPrefix2ExtLine] parameter.
You can enable and disable this external line functionality for specific FXS ports, using the Tel Profiles table's 'Line Type' parameter (see Configuring Tel Profiles).
The parameter is applicable only to FXS interfaces.

configure voip > gateway manipulation settings > prefix-2-ext-line

[AddPrefix2ExtLine]

Enables the device to add the prefix string for accessing an external line (configured by the Prefix2ExtLine parameter) to the dialed (called) number as the prefix, which is sent to the IP destination (for Tel-to-IP calls).

[0] = (Default) Disabled - the device does not add the prefix string for accessing the external line to the collected and sent dialed number. For example, if you configure the Prefix2ExtLine parameter to “9” and the FXS endpoint makes a call to destination number "123", the device collects and sends only the destination number digits "123" (i.e., without the prefix string) to the IP destination.
[1] = Enables the device to add the prefix string for accessing the external line to the dialed number as the prefix, which is sent to the IP destination. For example, if you configure the Prefix2ExtLine parameter to “9” and the FXS endpoint makes a call to destination number "123", the device collects and sends all the dialed digits, including the prefix string "9", as "9123" to the IP destination.
[2] = Same as option [1], but in addition, the device uses the prefix string for accessing the external line as the first digit in configured patterns of Digit Maps and/or Dial Plans. This option is useful in that it allows you to configure separate patterns for internal and external dialing. For example, if you configure the Prefix2ExtLine parameter to “9” and configure digit map patterns “2xxx|92xxxxxxx”, the device considers dialed numbers between 2000 and 2999 (2xxx) as internal extensions (i.e., when "9" is not dialed for an external line), and if the first dialed digit (prefix) is “9” (for accessing the external line), considers dialed numbers between 20000000 and 29999999 (92xxxxxxx) as external numbers.

Note:

The parameter is applicable only to FXS interfaces.
The parameter is applicable only to Tel-to-IP calls.

Hook Flash Parameters

'Flash Keys Sequence Style'

configure voip > gateway dtmf-supp-service supp-service-settings > flash-key-seq-style

[FlashKeysSequenceStyle]

Defines the hook-flash key sequence for FXS interfaces.

[0] Flash hook = (Default) Only the phone's flash button is used for the following scenarios:
During an existing call, if the user presses the flash button, the call is put on hold; a dial tone is heard and the user is able to initiate a second call. Once the second call is established, on-hooking transfers the first (held) call to the second call.
During an existing call, if a call comes in (call waiting), pressing the flash button places the active call on hold and answers the waiting call; pressing flash again toggles between these two calls.
[1] Sequence 1 = Sequence of flash button with digit:
Flash + 1: holds a call or toggles between two existing calls
Flash + 2: makes a call transfer.
Flash + 3: makes a three-way conference call (if the Three-Way Conference feature is enabled, i.e., the parameter Enable3WayConference is set to 1 and the parameter 3WayConferenceMode is set to 2).
[2] Sequence 2 = Sequence of flash button with digit:
Flash only: Places a call on hold.
Flash + 1:
1) When the device handles two calls (an active and a held call) and this key sequence is dialed, it sends a SIP BYE message to the active call and the previously held call becomes the active call.
2) When there is an active call and an incoming waiting call, if this key sequence is dialed, the device disconnects the active call and the waiting call becomes an active call.
Flash + 2: Places a call on hold and answers a call-waiting call, or toggles between active and on-hold calls.
Flash + 3: Makes a three-way conference call. This is applicable only if the Enable3WayConference parameter is set to 1 and the 3WayConferenceMode parameter is set to 2. Note that the settings of the ConferenceCode parameter is ignored.
Flash + 4: Makes a call transfer.
[3] Sequence 3 = User-defined sequence of flash button with digit(s) for various functionality, which is configured by the following parameters:
[FlashKeyToggleToSecondary]
[FlashKeyToggleToPrimary]
[FlashKeyCallTransfer]
[FlashKeyConference]
[FlashKeyByeAndToggle]
[FlashKeyByeToSecondary]

Note: The parameter is applicable only to FXS interfaces.

configure voip > gateway dtmf-supp-service supp-service-settings > flash-key-toggle-to-secondary

[FlashKeyToggleToSecondary]

Defines the flash-hook key with digit sequence for toggling from the primary call to the secondary call. When the key sequence is performed, the primary call is put on hold and the secondary call becomes active.

The valid value is 0 through 9, * (asterisk / star key), or # (hash / pound key).

Note:

The parameter is applicable only if you configure the 'Flash Keys Sequence Style' parameter to Sequence 3.
The parameter is applicable only to FXS interfaces.

configure voip > gateway dtmf-supp-service supp-service-settings > flash-key-toggle-to-primary

[FlashKeyToggleToPrimary]

Defines the flash-hook key with digit sequence for toggling from the secondary call to the primary call. When the key sequence is performed, the secondary call is put on hold and the primary call becomes active.

The valid value is 0 through 9, * (asterisk / star key), or # (hash / pound key).

Note:

The parameter is applicable only if you configure the 'Flash Keys Sequence Style' parameter to Sequence 3.
The parameter is applicable only to FXS interfaces.

configure voip > gateway dtmf-supp-service supp-service-settings > flash-key-call-transfer

[FlashKeyCallTransfer]

Defines the flash-hook key with digit sequence for initiating a call transfer.

The valid value is 0 through 9, * (asterisk / star key), or # (hash / pound key).

For example, if you configure the parameter to 2, a call transfer is performed as follows:

1. A establishes a call with B.
2. A places B on hold.
3. A makes a call to C.
4. A press the flash-hook key with the "2" key to transfer B to C.

Note:

The parameter is applicable only if you configure the 'Flash Keys Sequence Style' parameter to Sequence 3.
The parameter is applicable only to FXS interfaces.

configure voip > gateway dtmf-supp-service supp-service-settings > flash-key-conference

[FlashKeyConference]

Defines the flash-hook key with digit sequence for initiating a three-way conference call.

The valid value is 0 through 9, * (asterisk / star key), or # (hash / pound key).

For example, if you configure the parameter to 9, a three-way conference call is performed as follows:

1. A establishes a call with B.
2. A places B on hold.
3. A makes a call to C.
4. A establishes a three-way conference call with B and C, by pressing the flash-hook key with the "9" key.

Note:

The parameter is applicable only if you configure the 'Flash Keys Sequence Style' parameter to Sequence 3.
The parameter is applicable only to FXS interfaces.

configure voip > gateway dtmf-supp-service supp-service-settings > flash-key-bye-and-toggle

[FlashKeyByeAndToggle]

Defines the flash-hook key with digit sequence for ending the active call (sends a SIP BYE message) when you have two calls and one is on-hold. When the sequence is pressed, the previously held call becomes the active call.

The valid value is 0 through 9, * (asterisk / star key), or # (hash / pound key).

Note:

The parameter is applicable only if you configure the 'Flash Keys Sequence Style' parameter to Sequence 3.
The parameter is applicable only to FXS interfaces.

configure voip > gateway dtmf-supp-service supp-service-settings > flash-key-bye-2-secondary

[FlashKeyByeToSecondary]

Defines the flash-hook key with digit sequence for ending the call that is currently on hold (sends a SIP BYE message).

The valid value is 0 through 9, * (asterisk / star key), or # (hash / pound key).

Note:

The parameter is applicable only if you configure the 'Flash Keys Sequence Style' parameter to Sequence 3.
The parameter is applicable only to FXS interfaces.

'Flash Keys Sequence Timeout'

flash-key-seq-tmout

[FlashKeysSequenceTimeout]

Defines the Flash keys sequence timeout . This is the time (in msec) that the device waits for digits after the user presses the flash button, when flash hook with digit is enabled (FlashKeysSequenceStyle parameter is 1, 2, or 3).

The valid range is 100 to 5,000. The default is 2,000.

Keypad Feature - Call Forward Parameters

'Forward Unconditional'

configure voip > gateway analog keypad-features > fwd-unconditional

[KeyCFUnCond]

Defines the key sequence on the keypad to activate the immediate call forward option.

'Forward No Answer'

configure voip > gateway analog keypad-features > fwd-no-answer

[KeyCFNoAnswer]

Defines the key sequence on the keypad to activate the forward on no answer option.

'Forward On Busy'

configure voip > gateway analog keypad-features > fwd-on-busy

[KeyCFBusy]

Defines the key sequence on the keypad to activate the forward on busy option.

'Forward On Busy or No Answer'

configure voip > gateway analog keypad-features > fwd-busy-or-no-ans

[KeyCFBusyOrNoAnswer]

Defines the key sequence on the keypad to activate the forward on 'busy or no answer' option.

'Do Not Disturb'

configure voip > gateway analog keypad-features > fwd-dnd

[KeyCFDoNotDisturb]

Defines the key sequence on the keypad to activate the Do Not Disturb option (immediately reject incoming calls).

To activate the required forward method from the telephone:

1. Dial the user-defined sequence number on the keypad; a dial tone is heard.
2. Dial the telephone number to which the call is forwarded (terminate the number with #); a confirmation tone is heard.

'Forward Deactivate'

configure voip > gateway analog keypad-features > fwd-deactivate

[KeyCFDeact]

Defines the key sequence on the keypad to deactivate any of the call forward options. After the sequence is pressed, a confirmation tone is heard.

Keypad Feature - Caller ID Restriction Parameters

'Restricted Caller ID Activate'

configure voip > gateway analog keypad-features > id-restriction-act

[KeyCLIR]

Defines the key sequence on the keypad to activate the restricted Caller ID option. After the sequence is pressed, a confirmation tone is heard.

'Restricted Caller ID Deactivate'

configure voip > gateway analog keypad-features > id-restriction-deact

[KeyCLIRDeact]

Defines the key sequence on the keypad to deactivate the restricted Caller ID option. After the sequence is pressed, a confirmation tone is heard.

Keypad Feature - Hotline Parameters

'Hot-line Activate'

configure voip > gateway analog keypad-features > hotline-act

[KeyHotLine]

Defines the key sequence (e.g., *53*) on the keypad that activates the delayed hotline option.

The valid value is a string of up to 151 characters.
To activate the delayed hotline option from the telephone:

1. Dial the user-defined sequence number on the keypad; a dial tone is heard.
2. Dial the telephone number to which the phone automatically dials after a configurable delay (terminate the number with #); a confirmation tone is heard.

'Hot-line Deactivate'

configure voip > gateway analog keypad-features > hotline-deact

[KeyHotLineDeact]

Defines the key sequence on the keypad to deactivate the delayed hotline option. After the sequence is pressed, a confirmation tone is heard.

Keypad Feature - Transfer Parameters

Note: See the description of the [KeyBlindTransfer] parameter for this feature.

Keypad Feature - Call Waiting Parameters

'Call Waiting Activate'

configure voip > gateway analog keypad-features > cw-act

[KeyCallWaiting]

Defines the key sequence on the keypad to activate the Call Waiting option. After the sequence is pressed, a confirmation tone is heard.

'Call Waiting Deactivate'

configure voip > gateway analog keypad-features > cw-deact

[KeyCallWaitingDeact]

Defines the key sequence on the keypad to deactivate the Call Waiting option. After the sequence is pressed, a confirmation tone is heard.

Keypad Feature - Reject Anonymous Call Parameters

'Reject Anonymous Call Activate'

configure voip > gateway analog keypad-features > reject-anony-call-activate

[KeyRejectAnonymousCall]

Defines the key sequence on the keypad to activate the reject anonymous call option, whereby the device rejects incoming anonymous calls. After the sequence is pressed, a confirmation tone is heard.

'Reject Anonymous Call Deactivate'

configure voip > gateway analog keypad-features > reject-anony-call-deactivate

[KeyRejectAnonymousCallDeact]

Defines the key sequence on the keypad that de-activates the reject anonymous call option. After the sequence is pressed, a confirmation tone is heard.